Carbon


DrawThemeScrollBarArrows

Header: Appearance.h Carbon status: Supported

Draws scroll bar arrows consistent with the current system preferences.

OSStatus DrawThemeScrollBarArrows (
    const Rect *bounds, 
    ThemeTrackEnableState enableState, 
    ThemeTrackPressState pressState, 
    Boolean isHoriz, 
    Rect *trackBounds
);
bounds

A pointer to a structure of type Rect. Before calling DrawThemeScrollBarArrows, set the rectangle to contain the scroll bar for which to draw arrows, in local coordinates. Typically, the rectangle you specify is the entire base control rectangle—that is, the value contained in the contrlRect field of the scroll bar’s ControlRecord structure.

enableState

A value of type ThemeTrackEnableState. Pass a constant specifying the current state of the scroll bar; see “Theme Track Enable State Constants” for descriptions of possible values.

pressState

A value of type ThemeTrackPressState. Pass a constant specifying what is pressed in an active scroll bar or 0 if nothing is pressed. The press state is ignored if the scroll bar is not active. See “Theme Track Press State Constants” for descriptions of possible values.

isHoriz

A value of type Boolean. Pass true if the scroll bar is horizontal; pass false if it is vertical.

trackBounds

A pointer to a structure of type Rect. On return, the rectangle is set to the bounds of the track portion of the scroll bar; this rectangle excludes the area containing the scroll bar arrows. Pass NULL if you do not wish to obtain this information.

function result

A result code.

DISCUSSION

The DrawThemeScrollBarArrows function draws a set of theme-compliant scroll bar arrows for the scroll bar whose position and dimensions are specified in the bounds parameter. Depending upon the current system preferences, DrawThemeScrollBarArrows draws the arrows in one of the following configurations:

VERSION NOTES

This function is available with Appearance Manager 1.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)